Crate subplot

Process Subplot input files.

Capture and communicate acceptance criteria for software and systems, and how they are verified, in a way that’s understood by all project stakeholders.

Modules

• html
  A representation of HTML using Rust types.
• md
  A parsed Markdown document.
• mdparse
  Parse markdown into an HTML representation.
• resource
  Resources for subplot.
• toc
  Store information needed to build a table of contents for a document.
• typeset
  Typeset various data types into HTML.

Structs

• Binding
  A binding of a scenario step to its implementation.
• Bindings
  Set of all known bindings.
• Document
  A parsed Subplot document.
• DotMarkup
  A code block with Dot markup.
• EmbeddedFile
  A data file embedded in the document.
• EmbeddedFiles
  A collection of data files embedded in document.
• MarkupOpts
• MatchedScenario
  A scenario that has all of its steps matched with steps using bindings.
• MatchedStep
  A matched binding and scenario step, with captured parts.
• MatchedSteps
  A list of matched steps.
• Metadata
  Metadata of a document, as needed by Subplot.
• PikchrMarkup
  A code block with pikchr markup.
• PlantumlMarkup
  A code block with PlantUML markup.
• Scenario
  An acceptance test scenario.
• ScenarioStep
  A scenario step.
• StepSnippet
  The text of a part of a scenario step.
• Style
  Typesetting style configuration for documents.
• Svg
  An SVG image.
• TemplateSpec
  A template specification.
• Warnings
  A list of warnings.
• YamlMetadata
  Document metadata.

Enums

• PartialStep
  Part of a scenario step, possibly captured by a pattern.
• StepKind
  The kind of scenario step we have: given, when, or then.
• SubplotError
  Define all the kinds of errors any part of this crate can return.
• Warning
  A warning, or non-fatal error.

Traits

• DiagramMarkup
  A code block with markup for a diagram.

Functions

• codegen
  Generate code for one document.
• generate_test_program
  Generate a test program from a document, using a template spec.
• get_basedir_from
  Get the base directory given the name of the markdown file.
• load_document
  Load a Document from a file.
• load_document_with_pullmark
  Load a Document from a file.